DevForce Help Reference
InvokeServerMethodAsync(EntityManager,ServerMethodDelegate,Action<InvokeServerMethodOperation>,Object,Object[]) Method
Example 


Method to be invoked
Handler called when operation completes
Token identifying the asynchronous request
Arguments to be passed to method
Asynchronously invokes the specified static (Shared in Visual Basic) method for execution on the server.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function InvokeServerMethodAsync( _
   ByVal em As EntityManager, _
   ByVal serverMethod As ServerMethodDelegate, _
   ByVal userCallback As Action(Of InvokeServerMethodOperation), _
   ByVal userState As Object, _
   ByVal ParamArray userArguments() As Object _
) As InvokeServerMethodOperation
'Usage
 
Dim em As EntityManager
Dim serverMethod As ServerMethodDelegate
Dim userCallback As Action(Of InvokeServerMethodOperation)
Dim userState As Object
Dim userArguments() As Object
Dim value As InvokeServerMethodOperation
 
value = EntityManagerAsyncExtensions.InvokeServerMethodAsync(em, serverMethod, userCallback, userState, userArguments)

Parameters

em
serverMethod
Method to be invoked
userCallback
Handler called when operation completes
userState
Token identifying the asynchronous request
userArguments
Arguments to be passed to method
Exceptions
ExceptionDescription
System.InvalidOperationExceptionInvalid ServerMethodDelegate provided
System.ArgumentExceptionUserState token must be unique for the client
System.Security.SecurityExceptionThrown if the method is not marked with the IdeaBlade.EntityModel.AllowRpcAttribute
IdeaBlade.EntityModel.PersistenceSecurityExceptionThrown if the server method is decorated with a AuthorizationAttribute and fails authorization
Remarks
The method called must be marked with the IdeaBlade.EntityModel.AllowRpcAttribute and correspond to the ServerMethodDelegate signature.

InvokeServerMethodAsync enables a client-side caller to invoke an arbitrary static method on the server using an asynchronous call. The data returned from the server method will be available in the IdeaBlade.EntityModel.InvokeServerMethodEventArgs passed to the supplied callback.

Example
// Sample showing asynchronous invocation of server method

// In client class:
private void MakeAsyncCall() {
  EntityManager mgr = new DomainModelEntityManager();
  // Make async call
  Guid myToken = Guid.NewGuid();
  mgr.InvokeServerMethodAsync(new ServerMethodDelegate(Order.GetNumberOfOrdersSlow), 
      InvokeServerMethodAsyncCompleted, myToken, 
 	    new DateTime(1995, 1, 1), new DateTime(1999, 1, 1));
}
private void InvokeServerMethodAsyncCompleted(InvokeServerMethodOperation e) {
  Guid token = (Guid)e.UserState;
  if (!e.Cancelled) {
     MessageBox.Show("my async result = " + Convert.ToInt32(e.Result).ToString());
  }
}

// Sample method defined in Order entity class:
public class Order {
//...

  // ServerMethodDelegate method, called from client
  [AllowRpc]
  public static Object GetNumberOfOrdersSlow(IPrincipal pPrincipal, EntityManager pMgr, params Object[] pArgs) {
     // Sleep to make this slower to show async
     System.Threading.Thread.Sleep(2000);
     DateTime dt1 = pArgs[0] as DateTime;
     DateTime dt2 = pArgs[1] as DateTime;
     return pMgr.Order.Where(o => o.OrderDate >= dt1 && o.OrderDate <= dt2).Count();
  }
}
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

EntityManagerAsyncExtensions Class
EntityManagerAsyncExtensions Members
Overload List

Send Feedback